home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / ucvs100a.zip / UCVS.DOC next >
Text File  |  1990-05-31  |  15KB  |  378 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                    The User CallBack Verification System
  12.  
  13.                                 Version 1.0
  14.  
  15.                            Copyright (c) 1990 by
  16.  
  17.                      New Dimension Software Development
  18.  
  19.                    A service of New Dimension Enterprises
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.                          New Dimension Enterprises
  44.                            13012 Centerburg Road
  45.                              Sunbury, Oh  43074
  46.                              FidoNet 226/270.1
  47.  
  48. Welcome to UCVS!
  49.  
  50. Thank you for trying our User CallBack Verification System.  We hope that
  51. it will become an integral part of your BBS operations.  UCVS 1.0 currently
  52. has the following features:
  53.  
  54. * RA/QBBS compatible
  55. * Allows you (the SysOp) to define the format of user's phone numbers
  56. * Performs area code checking within the user's phone numbers
  57. * Allows mass phone number reformatting
  58. * Handles local, toll, and long distance calling
  59. * Toll and long distance calls made for verification ONLY
  60. * Bad verifies may be locked out, deleted, or left for investigation
  61. * Performs duplicate phone check and notifies you where the dupe is
  62. * SysOp definable text files for board personalization
  63. * Codeword function for extra security and to prevent script files
  64. * Complete flag and security level support (to 64000)
  65. * Supports multi-line operation using child directories
  66. * Support up to 38.4k baud transmissions
  67.  
  68. We hope you enjoy using UCVS.  If you have any problems or comments
  69. concerning the program or this documentation, coorespondence may be
  70. addressed to Mike Teegarden c/o New Dimension Enterprises at the address
  71. listed on the front page.  Netmail is a quicker way to get a response, but
  72. either method will be handled quickly.
  73.  
  74.  
  75.  
  76. Disclaimer:
  77.  
  78. This software is distributed as-is with no warranty, either expressed or
  79. implied.  The user assumes all responsibility for his use of this software
  80. and any damages that may occur.  Neither New Dimension Enterprises, nor it's
  81. representatives may be held responsible for any damages that may occur.
  82.  
  83.  
  84. Distribution:
  85.  
  86. This software is hereby released as SHAREWARE.  This means that you can use
  87. the software for a trial period of two weeks.  If at that time you decide
  88. you want to continue to use the program a registration fee of $ 12.00
  89. should be paid.  This registration fee will entitle you to a registration
  90. key which will remove the evaluation notice from the program.  This
  91. software is not crippled in any way.  All parts of the program function
  92. without the key, but the program will notify all your users that it isn't
  93. registered.  This key is good for all future versions of UCVS.
  94.  
  95.  
  96. Getting Started:
  97.  
  98. The UCVS archive should contain the following files:
  99.  
  100. UCVS.EXE - Main program
  101. UCVS.DOC - This file
  102. UCVSOPEN.TXT - Sample text file (opening screen)
  103. UCVSDUPE.TXT - Displayed if duplicate phone found
  104. UCVSCALL.TXT - Displayed to users who are toll or l/d
  105. UCVSTOLL.TXT - Defines a toll call to the user
  106. UCVSCONN.TXT - Displayed after reconnection with user
  107.  
  108. The following files are used by UCVS but must be created if used:
  109.  
  110. UCVS.CFG - The configuration file (The system creates this)
  111. UCVSAC.CTL - Area code exclusion file (Create if used)
  112. UCVSLONG.TXT - Text file displayed if user is calling from restricted A/C
  113.  
  114. Unzip the archive and place the EXE file in your main BBS directory.  Place
  115. the text files in another directory, preferably your text file directory.
  116. Return to your main BBS directory and enter UCVS /C to invoke the
  117. configuration system.
  118.  
  119.  
  120.  
  121.  
  122.  
  123. Configuration:
  124.  
  125. When the configuration function is first invoked it will inform you that
  126. the configuration file wasn't found and will ask if you want to create it.
  127. Answer Y to create your configuration file.  The screen will then come up
  128. with the default settings.  Change only the ones you want.  If you
  129. accidently press a key that you don't want to change, just press enter to
  130. leave the field as it is.  Here is a brief description of all the
  131. configuration options.
  132.  
  133. A. BBS Name:  Your BBS name as it is to be registered.  This is what your
  134. key is based on.
  135.  
  136. B. Dialing Prefix: The dialing command for your modem.  For hayes
  137. compatibles it's either ATDT or ATDP.  Check your modem's manual for the
  138. correct prefix.
  139.  
  140. C. Dialing Suffix: The command to end the dialing command.  Usually a C/R.
  141. Use the "|" symbol for a C/R.
  142.  
  143. D. Modem Init: The Init string for your modem.  Note: This should NOT be
  144. ATZ!  The only commands you will need to put here would be to turn off
  145. local echo, the speaker, or auto answer.  If you have your modem configured
  146. for auto answer, use this command shut it off.  Place the "|" at the end if
  147. needed.  If you don't need to init the modem leave the "AT|" command there.
  148.  
  149. E. Use Data Phone: Determines if the user can use his data phone number as
  150. a choice for the callback.  If set to "N" then the only number a user can
  151. use is the home number.
  152.  
  153. F. New User Sec: Security level needed for user to access UCVS.  Note: A
  154. local user can ALWAYS access UCVS. (If you have your menus set up that way)
  155.  
  156. G. Val User Sec: Security level user receives after successful
  157. verification.
  158.  
  159. H-K. Flags: These determine if any flag settings should be changed.  Use an
  160. "X" to turn a flag ON and a "-" to turn it OFF.  All other characters are
  161. ignored.  The "?" are used for place markers.
  162.  
  163. L. Call Type: Determines if system will make Local, Toll, or Long Distance
  164. calls.  If the system is setup for L/D calls, then all calls will be made.
  165. Also, if Toll calls are specified, only Local and Toll calls will be made.
  166.  
  167. M. BBS Type: Defines the type of BBS software being run.  Currently this is
  168. used only for logging purposes.  It determines either QBBS or RA/FD style
  169. logging.
  170.  
  171. N. Home Mask: The phone number mask for the home phone number.  Define it
  172. as you want.  QBBS users SHOULD leave it as it is because that is the
  173. format QBBS and many QBBS utilities use.  RA users can determine what type
  174. of phone mask to use.  The system only recognizes the "X" character.  Every
  175. "X" encountered in the mask is replaced with the cooresponding number in the
  176. current phone number. Please see the examples at the end of this document.
  177.  
  178. O. Data Mask: The phone number mask for the data phone.  See above.
  179.  
  180.  
  181.  
  182. Configuration (cont):
  183.  
  184. P. Text File Dir: Complete path to your text files.  Eg. C:\BBS\TEXT\  The
  185. system will add the ending "\" if you forget.
  186.  
  187. Q. Users File Dir: Location of USERS.BBS.  Location ONLY.  Eg. C:\BBS\
  188.  
  189. R. Area Code: Your local area code.  Used to determine local/toll calls
  190. from long distance.  Also asks if you want to verify area codes?  If set to
  191. "Y" and a user enters a phone number without an A/C AND there is room in
  192. the phone number field, the area code will be added to the phone number.
  193. This function is also used in the user phone number reformat option. (See
  194. Reformatting section)
  195.  
  196. S. Log File: Name and location of your log file.  Eg. C:\BBS\SYSTEM.LOG
  197.  
  198. T. Check Dupes: If set, the system will check the users phone numbers
  199. against all other phone numbers.  If a duplicate is found the user is
  200. displayed the UCVSDUPE file and returned to the BBS.  The user record
  201. number which contained the dupe is posted in the log file.
  202.  
  203. U. Bad Status: Determines what to do with bad verifies.  You can delete,
  204. lockout, or leave the record alone.  This takes effect immediately after
  205. the verification fails.
  206.  
  207. V. Use Codewords: Extra security function which causes user to enter a
  208. random codeword before entering his password.  If codeword check fails then
  209. verification fails.
  210.  
  211. W. Register Key: Registration key as sent to you after receipt of your
  212. registration fee.
  213.  
  214. After configuring the program to your likes enter "Z" and the config file
  215. will be written to disk.  Now your ready to use UCVS.
  216.  
  217.  
  218. Using UCVS:
  219.  
  220. Using UCVS is very simple.  First create a menu command to access UCVS.  It
  221. can be set up as either a Type 7 or Type 15 menu function.  If setup as a
  222. Type 7 use "UCVS.EXE *N" in your optional data field.  If setup as a Type 15,
  223. just use "UCVS" + node number in your batch file.
  224.  
  225. When invoked UCVS reads the configuration file, DORINFOx.DEF, and
  226. EXITINFx.BBS.  It then displays "UCVSOPEN.TXT" and prompts for which phone
  227. number to call. (If Use Data Phone is off or if the data phone doesn't
  228. exist, it won't ask which phone to call)
  229.  
  230. Note: The phone numbers are formatted BEFORE the user sees them.  If for
  231. some reason the phone number is not correct (user didn't enter an area code
  232. and doesn't live in your area, but the system put your area code on his
  233. number) then the user has the chance to stop the process by answering "N"
  234. to the "Is the above info correct" prompt.
  235.  
  236.  
  237. Using UCVS (cont)
  238.  
  239. If the information is correct, the system then determines what type of call
  240. the user is (Local, Toll, or L/D).  If the user's selected number has the
  241. same area code as you have setup in the configuration then the user is
  242. asked if the phone call will be a toll call.  A toll call is defined as a
  243. call in the same area code which requires a 1 be dialed before the number.
  244. (Eg. 1-555-1212).  If the user's phone number is a type which your
  245. configuration doesn't permit (user is L/D and you only accept Local) then
  246. the system display the "UCVSCALL.TXT" file and returns to the BBS.
  247.  
  248. The system will the check for dupes (if set) and select a codeword (if
  249. set) for the user.  The user then has one last chance to abort the
  250. verification process.  If the user continues with the verification, the
  251. system drops DTR and re-inits the modem.  The system will try three (3)
  252. times to call the user back.  If all three fail, the verification fails and
  253. the user record is dealt with as defined in your configuration.  If a
  254. connection is made, the user has three chances to enter his codeword (if
  255. set) and then three chances to enter his password.  If any of these fail,
  256. the verification fails.  NOTE: The system will try to reconnect at the same
  257. speed the user called in at.  If the system can't get a connect at the same
  258. speed, that call fails.
  259.  
  260.  
  261. UCVS Extras:
  262.  
  263. UCVS has the following SysOp hot keys:
  264.  
  265. Alt-C - Enter chat mode (ESC to exit)
  266. Alt-H - Hangup user (twit key)
  267. Alt-L - Lockout User
  268.  
  269. The text files are distributed only as samples.  Feel free to use them in
  270. your system if you like.  If you'd like to change the files or create new
  271. ones, the following control codes will control color displays within the
  272. files.
  273.  
  274. ~a - Blue                  ~i - Lt Blue
  275. ~b - Green                 ~j - Lt Green
  276. ~c - Cyan                  ~k - Lt Cyan
  277. ~d - Red                   ~l - Lt Red
  278. ~e - Magenta               ~m - Lt Magenta
  279. ~f - Brown                 ~n - Yellow
  280. ~g - White                 ~o - High Intensity White
  281. ~h - Gray
  282.  
  283. These codes are replaced with their ansi equivalent and sent to the remote
  284. user.
  285.  
  286.  
  287. Area Code Exclusion:
  288.  
  289. If you are running your system to make L/D calls, you can create a file
  290. called "UCVSAC.CTL" which contains area codes to EXCLUDE from calling.  The
  291. format of this file is simply one area code per line (straight ascii text
  292. file).  If found, the system will scan the list, and if the user's area
  293. code is found, the file "UCVSLONG.TXT" will be displayed and the user will
  294. be returned to the BBS.  Note:  You DO NOT need these two files to run the
  295. system.  They are simply extras to be created if needed.
  296.  
  297.  
  298. A note about calls:
  299.  
  300. The UCVS program is setup to make local calls and upon successful
  301. verification, return the user to the BBS.  Toll and L/D calls are made on a
  302. VERIFY ONLY basis.  Upon a successful verification, the user's info is
  303. updated and the call is cancelled.  If you don't want to bother with Toll
  304. or L/D calls, set your configuration to Local Only.
  305.  
  306.  
  307. Phone mask exmples:
  308.  
  309. Here a few examples of phone mask conversion:
  310.  
  311. User's phone                  Mask                    Result
  312. ------------                  ----                    ------
  313. 8005551212                   XXX-XXX-XXXX             800-555-1212
  314. 800555-1212                  XXXXX-XXXX               80055-5121
  315. 5551212    (no a/c check)    XXX-XXX-XXXX             555-121-2
  316. 555-1212   (a/c check)       XXX-XXX-XXXX             AAA-555-1212  AAA=A/C
  317.  
  318. Note:  Only the numbers are transferred.  If the user placed the "-" in his
  319. phone number, it doesn't matter.  UCVS only worries about the individual
  320. numbers (0-9).
  321.  
  322.  
  323. Reformatting:
  324.  
  325. UCVS also includes a mass phone number reformatting function.  To invoke
  326. this function enter UCVS /F.  Note: This function is immediate.  No double
  327. checking of any kind.  It will use the mask definitions in your config file
  328. and will also perform area code verifying if on.  PLEASE make a backup copy
  329. of your user's file BEFORE using this function.  If there is an incorrect
  330. mask in your configuration, your users' phone numbers WILL be difficult, if
  331. not impossible, to read.  Also note that this function should NOT be run on
  332. a multi-line system if someone is on the system.  If it is, irrepairable
  333. damage to the user file could result.  This should only be used if formats
  334. are changed or to initially format your user file.
  335.  
  336.  
  337. Multi-line Operation:
  338.  
  339. UCVS uses the DORINFOx.DEF and EXITINFx.BBS files to retrieve information
  340. about the user, the "x" representing the node number being run.  If you
  341. specify a node number in the command line, that number is used to determine
  342. which files will be looked for.  UCVS defaults to a single line system
  343. using DORINFO1.DEF and EXITINFO.BBS.  Any other parameter specified on the
  344. command line, other than /F and /C, are considered node numbers.  For
  345. proper operation, UCVS requires that DORINFOx.DEF, EXITINFx.BBS, and
  346. UCVS.CFG be located in the same directory.  The UCVS.EXE program may be
  347. left and run from your main RA directory.  Just specify the entire location
  348. of UCVS in the command line.  Eg. C:\RA\UCVS 2
  349.  
  350. Status Line:
  351.  
  352. The status line contains the follwing information:
  353.  
  354. User's Name
  355. Where user is calling from
  356. Connected baud rate or [L] for local
  357. [G] if graphics enabled
  358. Node number operating
  359.  
  360.  
  361. Registration:
  362.  
  363. To register your copy of UCVS send $ 12.00 (check or money order) along
  364. with your name, address, a fidonet address (if applicable) and your BBS
  365. name as you have it in field A of your configuration file.  The BBS name
  366. MUST be included to get your key.  Please allow 2 weeks for snailmail and 1
  367. week for netmail reply.  Send this information to:
  368.  
  369. New Dimension Enterprises
  370. re: UCVS Registration
  371. 13012 Centerburg Rd.
  372. Sunbury, Oh  43074
  373.  
  374. Questions and comments can be forwarded to the above address or fidonet address
  375. 226/270.1
  376.  
  377.  
  378.